ModifyVpnGatewayAttribute

Description

call the ModifyVpnGatewayAttribute interface to modify the name and description information of the VPN gateway.

Request Method

POST

Request Path

/apsara/route/Vpc/ModifyVpnGatewayAttribute

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
Description	BODY	string	No	vpn gateway	description information of VPN gateway. is 2 to 256 characters in length and must start with a letter or Chinese, but you cannot use http:// or https:// beginning.
VpnGatewayId	BODY	string	Yes	vpn-bp1q8bgx4xnkm2ogj****	the id of the VPN gateway instance.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
RegionId	BODY	string	Yes	cn-qingdao-env66-d01	the region ID of the VPN gateway instance. You can obtain the region ID by calling the DescribeRegions interface.
ClientToken	BODY	string	No	02fb3da4-130e-11e9-8e44-0016e04115b	client token to ensure the idempotence of the request. the parameter value is generated by the client, which is unique between different requests and does not value more than 64 ASCII characters at most.
version	BODY	string	No	2016-01-01	version of api
Name	BODY	string	No	myvpn	the name of the VPN gateway. The length is 2 to 128 characters, must start with a letter or Chinese, and can contain numbers, half-width periods (.), underscores (_), and dashes (-). But you cannot use http:// or https:// beginning.

Return data

Name	Type	Sample value	Description
Status	string	active	status of VPN gateway.
Description	string	test	description information of VPN gateway instance.
VpcId	string	vpc-bp1ub1yt9cvakoel****	ID of the VPC to which the VPN gateway instance belongs.
InternetIp	string	116.XX.XX.69	the public IP address of the VP gateway instance.
EndTime	long	1495382400000	the expiration timestamp of the VPN gateway instance.
RequestId	string	54B48E3D-DF70-471B-AA93-08E683A1B457	request ID.
VpnGatewayId	string	vpn-bp1q8bgx4xnkm2ogj****	the id of the VPN gateway instance.
VSwitchId	string	vsw-bp1y9ovl1cu9ou4tv****	ID of the switch to which the VPN gateway instance belongs.
CreateTime	long	1492753580000	the creation timestamp of the VPN gateway instance.
Spec	string	5 Mbps	the specification of the VPN gateway instance.
IntranetIp	string	172.XX.XX.104	private network IP of VPN gateway.
Name	string	test	the name of the VPN gateway instance.

Example

Successful Response example

{
 "Status":"active",
 "Description":"test",
 "VpcId":"vpc-bp1ub1yt9cvakoel****",
 "InternetIp":"116.XX.XX.69",
 "EndTime":"1495382400000",
 "RequestId":"54B48E3D-DF70-471B-AA93-08E683A1B457",
 "VpnGatewayId":"vpn-bp1q8bgx4xnkm2ogj****",
 "VSwitchId":"vsw-bp1y9ovl1cu9ou4tv****",
 "CreateTime":"1492753580000",
 "Spec":"5 Mbps",
 "IntranetIp":"172.XX.XX.104",
 "Name":"test"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}